BBS Toolkit/BBS Toolkit.iso/qbbs/qmx_120.zip/QMX_110.DOC

Text File | 1990-01-27 | 24KB | 487 lines

               Q u i c k p o i n t   M a i l   e X p r e s s

          V e r s i o n  1 . 1 0  -*-   F e b r u a r y,  1 9 9 0

                          ***********************

              Program CopyRight (C) 1989, 1990 by Mike Ratledge

    Documentation written and all rights reserved by Ed Meloan of 360/1

                          ************************

IMPORTANT!  QMX Version 1.10 uses INTERNAL FOSSIL support!  Please DO NOT USE
ANY CARRIER WATCHDOG PROGRAM OR DOS REDIRECTION SUCH AS CTTY/FOSLAUX/GATEWAY
and WATCHCD!

                          ************************

Welcome to Quickpoint Mail eXpress!!

QMX is An exciting new way for your callers to get all the messages they are
interested in and =READ THEM AFTER THEY LOG OFF=.  This new system allows
your users to do the following:

         1.  Custom select the Message Areas =THEY= want to read

         2.  Collect the new messages from these areas =AND= ALL
             messages addressed to them even in areas they don't select.

         3.  Pack them in an archive and send them to their computer

         4.  Lets your user read them while off-line, freeing your board
             for the next caller!!

         5.  The companion XRS Response system gives your caller an
             EXCELLENT full-screen editor that allows them to read,
             reply and edit all their messages WHILE OFF-LINE!

         6.  Pack their replies and send them back to this BBS where
             QMX will automatically place them in the correct message
             areas just as if the user had written them there.











                              Page 1
Read the following information and you'll be on your way to providing your
QuickBBS users with this exciting new feature!

If you're already running ECHOMAIL - then you are well on your way already!
Since QMX depends on an AREAS.BBS file to know where to place incoming
messages, you'll need to have that file set up.  One point here is that you
=MUST= setup names for EVERY message area...  Even ones which normally do not
handle ECHOMAIL.  This allows your present echomail processing to properly toss
LOCAL as well as ECHO messages into the correct message areas.  NOTE!! QLINK
(QuickBBS 2.6+) will NOT link areas which have the area name ONLY and nothing
else on the line!  Jim Westbrook suggests simply placing the word LOCAL where
you would normally have the node number to which you are tossing.  I have
just begun to try this but it seems to work well.

[A note here that while QMX can handle AREAS.BBS area names in lower case,
some mail tossers can not!  QuickBBS DOCS mention that all area names should
be in UPPER CASE.]

The XRS program requires group zero to be a local message area, and therefore
XRS always shows "00 LOCAL" as the first available group.  This 00 area is
inherited from the TCOMM program, for which XRS was originally written, and
really has no function in the QuickBBS environment.  You should setup the main
general local area of your BBS with the area name "LOCAL", so that the mail
tosser will place the inbound traffic into the correct area.  This can be ANY
message area number as long as it is named LOCAL in AREAS.BBS. Since there is
no 00 area, as there is in TCOMM, you will want to use one of your regular
area numbers.  This feature is required because all your users may not have
access to NetMail - they cannot send private message back to your BBS (XRS
will =ONLY= allow private status on NetMail, Local or in response to a private
message)!

Setting up QMX
==============
QMX is compiled in TWO versions.  Select QMX.EXE for use on XT (8088/8086)
systems and QMX_286.EXE for V20/80286/80386 systems and place the correct
version in your QuickBBS directory.

Complete file sharing and record-locking for updates is enabled *if* DOS
"Share" is detected.  Assuming Share *is* detected, QMX looks for "TCNODE" in
the DOS environment to determine the node number the user is on (i.e. "SET
TCNODE=2" for node 2, etc), and then uses BAT2MAIL.XRS, MAIL2IDX.XRS,
SUMMARY2.XRS, USER2.XRS & AREAS2.XRS, all of which get archived into the file
BAT2MAIL.* (except for local SysOp if "SysOpOut" parameter is in affect. Also:
QMX will look for DORINFOx.DEF, and EXITINFx.BBS where 'x' = TCNODE if file
sharing is in effect (in other words DORINFO2.DEF & EXITINF2.BBS for node 2).

QMX =ASSUMES NODE 1= so single-line systems with Share enabled are not treated
like networks and the use of the TCNODE environment variable is only required
for true multi-line systems.



                                Page 2
Using file sharing and record-locking, multiple users can all access the
databases at one time, but NOTE:  This assumes your BBS software supports
multi-user file-sharing and record-locking, which the current version (2.61)
of QuickBBS does not, and it further assumes your software puts the door info
and exit info into the above named files (or you copy it there for QMX)!  Full
support for the "RemoteAccess BBS" software is included.  QMX looks for *any*
file with an extension of ".RA" and if one is found, QMX becomes a chameleon
and plays like it is "RAX" (Remote Access eXpress) which in turn makes XRS
3.12 and later tag the tear and origin lines with proper identities.  Please
see Peter Jannsens' writeup and batch file examples for using QMX with Remote
Access in the included file "R_ACCESS.QMX".  Note: native Dutch message & help
overlays for XRS (Peter and friends) and Dutch language documentation by Rudi
Kusters is available, making XRS truly bi-lingual, soon to become multi-
lingual!  If you need Dutch language support for XRS, contact Peter or Mike
Ratledge for further details.

QMX must be set up as a Type 15 external program.  It will NOT work as a type
7 option.  Here are the steps to set QMX up as a type 15 menu option: (however
note that under RemoteAccess, the type 7 call (see R_ACCESS.BAT) will work)

Decide on an error level and add the following lines to your QuickBBS or
Mailer BAT file.  Let's assume we decide to use 98 as our level.  We would set
up a type 15 menu option with 98 as the optional data.  Do not type the
comments that are in brackets.

:After_Quick
   If errorlevel 98 goto Qmx      (ADD this line)
   If errorlevel 5 goto Both      (You probably already have this line)
   If errorlevel 4 goto NewEcho   ( "     "        "     "     "    " )
   If errorlevel 3 goto NewNet    ( "     "        "     "     "    " )
   Goto Loop  (or whatever you call your starting section of BAT file)


Since QMX version 1.10 has its own internal FOSSIL handling and carrier
detection, you will not need nor should you use redirection devices such as
CTTY or GATEWAY or carrier monitors such as WATCHCD.  Please =DO NOT= use
them.  All you will need in your BAT file will be something like this:

:Qmx
   QMX_286 (or QMX.EXE)
   QuickBBS -R -E0
   Goto After_Quick

!!!IMPORTANT!!!
You =MUST= have the popular archiving programs PKARC, PKZIP, and LHARC as well
as a recent version of ZMODEM AVAILABLE IN YOUR PATH STATEMENT!!  We cannot
emphasize this too strongly.  Having them in the QuickBBS sub-directory is not
necessarily enough if you don't have that sub-dir in the path statement!

NOTE: QMX uses DSZ.COM to provide external protocol support.  It does not
select the COM: port for DSZ!  If you use COM2: (or anything other than the
default COM1: address) you must place the following command immediately
before QMX in your batch file: SET DSZPORT=2

                                 Page 3
SET DSZPORT=2 would tell DSZ to use COM2:, for example.  You should also place
a similar command after QMX without the '2' (but no spaces after the '='
either!), and you will free up the environment string space it uses.


QMX IS HARD-CODED TO PUT UPLOADED FILES INTO A NEW SUB-DIRECTORY NAMED \QMX ON
THE CURRENT DRIVE.  You will need to MAKE A DIRECTORY, off the root, called
QMX.  You must move the incoming message files, from your users, into your
normal inbound net files area for processing by your echomail software.  To do
this automatically, you'll need to add the following lines to your BAT file to
handle the incoming mail.  Place this line so that it is read either before or
after every call!

   If exist \QMX\xxxx????.* goto QmxMail
                 ^^^^
(Note: this number will always be the same for your system, but it will *not*
 actually be "xxxx" - for example, "73E3" is the number XRS will use if you
 are in net 360.  It is computed exactly like a normal FidoNet echomail bundle
 name would be computed by subtracting net numbers - in hex, of course)


Now place the following lines IMMEDIATELY before (above) your section that
tosses incoming echomail.

:QmxMail
   COPY \QMX\xxxx????.* \FD\FILES (Replace \FD\Files with YOUR incoming
   DEL \QMX\xxxx????.*             mail directory)


:Toss_Echo  (Start of your regular ECHO tossing section)
   CD\QBBS
   Qecho -A -P -T -U   (or EchoGen, TosScan or Zmail...)
   Goto Loop

This will copy the new incoming messages into the correct area and then drop
through to your regular tossing program.

QMX exits with different errorlevels to tell you whether an upload was
received and/or mail was downloaded.  ErrorLevel = 0 means no errors and
neither u/l or d/l was used.  ErrorLevel 1 means mail was downloaded, a 2
means mail was uploaded and a 3 means both upload and download of mail.

A new option is available in 1.10 which allows the user to get their mail,
automatically update their "last read" pointer and automatically LOG OFF!
Three new error levels have been added for those who wish to control mail
handling through error codes.  4 indicates automatic logoff (no download), 5
indicates auto-logoff with a mailbag downloaded and 6 means auto-logoff with
both upload and download of mail. (All higher exit codes indicate other
program failure of some type!) These error levels can be used to direct
specific BATCH file activities if desired.  Please note!  It is NOT necessary
to use these codes unless you wish to do so.  QuickBBS will recover from the
AUTO-LOGOFF without their use and mail will be tossed normally.

                                Page 4
QMX allows the SysOp to control certain functions by editing a "configuration"
file.  This file is named: QMXSETUP.CFG.  Here are the options in QMXSETUP.CFG
along with brief descriptions of the options function.  Remove the semi-colon
to ENABLE the option.

;NoBeep - Turns off beeps on SysOp side.

;OutPath x:\path - Allows you to have QMX automatically place the resulting
            BAT1MAIL.xxx archive file into a different subdirectory.
            The "X:\PATH" portion *MUST* point to a directory
            name! (you can't change the final filename, anyway)

;SysopOut x:\path - [NEW in 1.10] Allows THE SYSOP (User 0) to have QMX
            automatically place an UNARCHIVED MAILBAG into a different
            subdirectory (only if logged in locally).  The "X:\PATH"
            portion *MUST* point to a directory name!

;NoBuff -  Disable file buffering on MSGHDR.BBS and MSGTXT.BBS - on some
           systems it may be faster to *not* buffer these files!

;LockBaud - Force Hardware Flow Control on DSZ - required for HST's, etc!

;ShowFiles - Show New Uploads ON SCREEN during FileScan.  Files will ALWAYS
             be included in the XRS <F6>Summary if FLEARCH.QMX is present.
             More on FLSEARCH.QMX later.

;NoBreak - To disable <CTRL-BREAK/C/K> exits from external batch files,
           you may use the this parameter.  NOTE:  The user cannot
           interrupt the program except by hanging up if this is turned on!
           Under normal conditions, this option should be left turned OFF!
           (When left off, the user is sent back to the BBS when he hits
           <CTRL-BREAK/C/K>...)

;Point 666 - In order to run in "No Points" mode, or to assign a specific
           point number to all QMX/XRS users, place a number from 0 up to
           32767.

;Limit 500 - To use a different maximum limit of messages for one mailbag,
           assign any number less than 995 to the following

;Defer -  Disable the internal DSZ downloads (so user can d/l from normal
          files area) [NOT NEEDED if OUTPATH is used]

;BBSID -  [New in 1.10]  accepts an 11-character filename (*without*
          pathname!) and inserts that file into the mailbags for use with
          external routines to manipulate and manage response mailbags
          according to the BBS from which it was downloaded.
          Example: "BBSID EBAYXCHG.XRS".  This should be a *small* file
          - possibly even zero length or one byte would be OK.




                                  Page 5
Version 1.10 gives you more control over the "new" files listings.  QMX now
looks for FLSEARCH.QMX instead of FLSEARCH.CTL - if not found *NO* "New File
Search" is done at all!  This way you can just search one or two if that is
what you want, or you can turn it off altogether.  If you want it to work like
before, just "COPY FLSEARCH.CTL FLSEARCH.QMX". (the format of the file is
*exactly* like FLSEARCH.CTL!)  If you do not want to search ALL areas, simply
copy FLSEARCH.CTL to FLSEARCH.QMX and then edit out the lists you do not want
included in the search.  Systems that do not have downloading are no longer
required to have a dummy copy of FLSEARCH.CTL.

You can also automatically restrict the user-side program (XRS) from sending
any mailbags in formats you can't process by placing a file named ARC_ONLY.XRS
(or ZIP_ONLY.XRS, but not both!) into the QuickBBS subdirectory.  When XRS
sees this file it will only use the desired method to pack the mail.  Note
that "SPAZ" is available in the archive and handles *any* compression type!

You may also "Force" your users to use YOUR origin line if you like.  To do
this just create a file called XORIGIN.XRS which contains the desired line (in
plain ASCII).  If XORIGIN is present, QMX will place a CRC value in the users
file which can be read by XRS version 3.12 or later.  This CRC check will not
allow the user to replace YOUR line with one of his own.  A CRC check is also
performed on the users name.  If either are incorrect XRS will terminate
immediately.

The new "OutPath x:\path"  Allows you to have QMX automatically place the
resulting BAT1MAIL.xxx archive file into a different subdirectory. The
"X:\PATH" portion *MUST* point to a directory name! (you can't change the
final filename, anyway)  You should DELETE this file automatically at logoff
time to prevent users from reading someone else's mail.


That's all there is to it!  Here's a short check list of what we have done.

1.  Make sure ALL message areas are listed in AREAS.BBS
2.  Create a directory called QMX OFF THE ROOT, not off QuickBBS subdirectory!
3.  Add a Menu option to allow your users to access QMX
4.  Add the necessary lines to your BAT file to handle a Type 15 menu
    option exit.
5.  Add the necessary lines to MOVE incoming QMX mail to your ECHO tossing
    directory
6.  Edit QMXSETUP.CFG and place it and QMX.EXE in the QuickBBS directory.
7.  Make a copy of FLSEARCH.CTL and name it FLSEARCH.QMX =IF= you want new
    files listed.









                                 Page 6
Using QMX
=========

Important!  Your caller MUST have a CONFIG.SYS file setup on their system
with a FILES equal AT LEAST 20!  Failure to do this will cause the XRS
program to be unable to unpack mail.  If a user complains about this problem,
that should be the first thing you ask about.  They should also download a
small mailbag BEFORE running XRS the first time.  XRS will look for mail and
complain if it can't locate any!  (this also can cause the program not to
"see" other files that *are* there...)

Your callers will find running QMX to be basically intuitive.  The first time
your user goes into QMX they will be asked to select their default message
areas to read, the message packing method and transfer protocol to be used.
Message area selection must be done before the caller can "Pack for Download".

Unconfigured (new) users are not given the option to download messages UNTIL
they have completed their configuration.

When selecting message areas the first time, your users should select from
"All" groups instead of only those which have new messages!  This will allow
them to select from all available groups and save these defaults for use every
time until they change them (and not miss any areas that do not have "new"
messages available at the current time).

The users SECURITY level and AUTHORIZATION flags determine the areas from
which they can select messages.  If a message area has a higher security level
on EITHER read OR WRITE, they will be unable to select or read the area.
Please make sure you understand the last sentence!  The user must be able to
both read =AND= write to an area or it will not be available.  The ability to
READ but NOT write will NOT get the user the area!  The user must also have
any authorization flags that you have assigned to an area.

The number of messages XRS can handle in one "MailBag" is 995, so that is
also the maximum number of messages QMX will extract before beginning the
archiving process - normally, a caller will probably get much less mail than
that!  QMX will normally default to a message number that gives the LAST 20%
of the messages FOR A FIRST TIME USER.  This prevents a first time caller from
accidentally downloading a packet of ALL the messages!  As Sysop, you can set
the maximum limit lower than 995 by using the LIMIT option in your
QMXSETUP.CFG file.

Note that QMX (and the XRS reader/editor) do not do "exact" matching as far
as upper/lower case letters go!  You will always get all messages addressed
to you no matter how the names are capitalized by the sending system!

(XRS never changes "Name Case")


QMX will =ALWAYS= automatically extract =ALL= mail addressed to the caller
whether or not they have the message's group selected.  That way, the caller
can be assured that they won't miss any mail even if they don't regularly read
certain conferences.  It also never extracts messages from the caller since it

                                 Page 7
assumes they have seen them before!  QMX allows a caller to select message
areas that have PRIVATE messages.  When scanning these areas, it will pack
mail addressed to the caller (or marked "Public") ONLY.

QMX will ask if you wish to update the HighMsgRead and/or LASTREAD.BBS fields,
assuming you read new message (you can select "Pack" from the main menu and
"backtrack" to old messages!).  You should, in general, always answer "Yes"!

You will want to make the XRS eXpress Response Reader available to your
callers.  The Reader comes with it's own documentation included in the
package.  Again, there are two versions.  One for XT type machines and
one for AT systems.  Current versions are XRS31EXE.ZIP (generic 8088/8086)
and XRS31EX!.ZIP - the V20/30/80286/386 edition. Overlay versions are also
available as XRS31OV.ZIP and XRS31OV!.ZIP.  Overlay versions require less
memory but will not run as quickly on slower machines.  XRS31COR.ZIP provides
the documentation AND other files needed for ALL versions and =IS REQUIRED= to
use XRS.  XRS31KITS.ZIP provides sample scripts for various communications
programs plus Dutch native-language support overlays and is optional.

QMX operates as a pseudo-point system.  The callers "point" number is
determined by QMX the first time the user selects any options in the
configuration menu of QMX.  The user will be assigned the next consecutive
number above the last assigned QMX user.  The information that QMX needs for
each user is kept in a small file named QMX_CONF.SYS.  Since QMX maintains
its own data file, you can sort and pack your userlog at any time without
any effect on QMX.

A small program (QMX_STAT) is included in your package.  This program allows
you to list your point users and their assigned numbers, with statistics.
QMX also places information about how many messages are downloaded, mailbags
received, groups selected and other information in your SYSTEM.LOG file.

As a point of information, XRS uses 30027/xxx as the "From" address in the
outbound message bundles.  This has NO effect on your systems actual node
number and can be ignored!  ('xxx' always = 0 if running "No Point" mode)
Be sure to add "PointNet 30027" to your echomail processor's configuration
file if you run in 'secure' mode!  This pseudo "PointNet" number was (and
other pointnet numbers are) assigned by the Zone Coordinator.


QMX watches the users input and features an automatic user entry timeout set
at three minutes.  This is integrated in the FOSSIL input routines.  After two
minutes with no activity, the program will beep three times signaling that it
is waiting for input.  If another full minute elapses without any response,
the program is terminated.

QMX looks for the file named "EXPRESS.BBS" and copies it into the top of
SUMMARY1.XRS each time the program is run.  This allows you to have a custom
BBS "banner" of special message that will pop up in the users' editor <F6>
summary/index window every time!  You should not use color graphics in this
file, since the summary/index routine pokes characters into memory for speed
and therefore does not allow for ANSI interpretation...   This allows you to
have a special announcement capability for QMX/XRS users.  You could place
notices of new versions being available in there, as well.

                                 Page 8
We have also included a short 'PROMO' file for your use to announce the
addition of Quick eXpress to your system.  You'll find it included as
BULLETIN.ASC, should you want to use it in your 'NEWS.ASC' or 'BULLETIN.ASC'
files.

We think you going to like this new way of communicating with your system!  It
allows your best and most active callers to get on, get their mail and get off
in much less time.  If you have questions, suggestions or problems, we'll be
happy to try and help.

A FidoNet "EchoMail" conference with AREA: tag "QMX_XRS" is available from
the echomail "backbone" system.  You'll find lots of friendly help and lively
discussion of topics of interest to QMX SysOps in this conference.  You should
be able to get connected easily via your local Network Echo Coordinator!



Documentation for Quickpoint Mail eXpress module written by:
Ed Meloan, SysOp of The Augusta Forum QuickBBS system (360/1)
and Michael Y. Ratledge and dated February 1, 1990



(C) CopyRight 1990 by Michael Y. Ratledge, CDP, CSP
SysOp of East Bay X-Change Multi-Node TCommNet BBS in Charleston, SC, USA
FidoNet addresses: 1/112, 1/318, 372/0, 372/555, 372/666, 372/777, 372/888
Compuserve Information System ID: 76666/1512
























                                    Page 9